home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / archiver / shar.arc / SHAR.ASC < prev    next >
Text File  |  1989-09-12  |  4KB  |  93 lines
  1. NAME
  2.      shar - create  shell archive on Atari ST for  extraction  by 
  3.             /bin/sh (Unix) or with shar itself
  4.  
  5. SYNOPSIS
  6.      shar [[-eo] archive] [-abcmsuv] [-p prefix] [-d delim]
  7.           [files >archive]
  8.  
  9. DESCRIPTION
  10.      shar  prints  its  input files with  special  command  lines 
  11.      around them to be used by the Unix Bourne shell, /bin/sh, or 
  12.      shar  itself to extract the files later.  The output can  be 
  13.      filtered  through  the  shell  to  recreate  copies  of  the 
  14.      original files.
  15.  
  16.      shar  allows directories to be named,  and shar  prints  the 
  17.      necessary  commands (mkdir & cd) to create  new  directories 
  18.      and  fill  them.  shar will not allow existing files  to  be 
  19.      over-written  if  the shell archive is  extracted  with  the 
  20.      Bourne Shell; such files must be removed by the user.
  21.  
  22. OPTIONS
  23.      -a All the options. The options: -v -c -b -p XX are implied.
  24.  
  25.      -b Extract files into basenames so that files with  absolute 
  26.           path  names are put into the  current  directory.  This 
  27.           option   has  strange  effects  when  directories   are 
  28.           archived.
  29.  
  30.      -c Check file size on extraction by counting characters.  An 
  31.           error  message  is  reported to the  person  doing  the 
  32.           extraction if the sizes don't match. One reason why the 
  33.           sizes may not match is that shar will append a  newline 
  34.           to  complete  incomplete  last  lines;  shar  prints  a 
  35.           message  that mentions added newlines.  Another  reason 
  36.           why  the sizes may not match is that some network  mail 
  37.           programs remove non-whitespace control characters. shar 
  38.           prints  a message that mentions control  characters  to 
  39.           the extractor.
  40.  
  41.      -d Use this as the ``end of file'' delimiter instead of  the 
  42.           default. The only reason to change it is if you suspect 
  43.           a file contains the default delimiter: SHAR_EOF.
  44.  
  45.      -e Extract a shell archive.  Files stored within an existing 
  46.           shell  archive are written to disk as  seperate  files. 
  47.           Directories are created as neccessary. Already existing 
  48.           files  will not be overwritten.  Options -c,  -m or  -v 
  49.           specified  upon creation of the shell archive  are  not 
  50.           regarded.
  51.  
  52.      -m Reset  the exact protection modes of files when they  are 
  53.           extracted (using the chmod program).  By  default,  the 
  54.           extractor's default file modes are used, and executable 
  55.           files (e.g., shell scripts) are made executable.
  56.  
  57.      -o Extract a shell archive with overwrite. Similar to the -e 
  58.           option but already existing files will be overwritten.
  59.  
  60.      -p Use  this  as  the prefix to each line  of  the  archived 
  61.           files.  This is to make sure that special characters at 
  62.           the  start of lines are not eaten up by  programs  like 
  63.           mailers.  If  this option is used,  the files  will  be 
  64.           extracted with the stream editor sed rather than cat so 
  65.           it is more efficient and portable to avoid setting  the 
  66.           prefix, though perhaps less safe if you don't know what 
  67.           is in the files.
  68.  
  69.      -s Silent running.  All checking and extra output is inhibi-
  70.           ted.
  71.  
  72.      -u Archive  the  input files with the  uuencode  format  for 
  73.           later extraction with uudecode.  This will allow you to 
  74.           send  files with control characters in them,  but  will 
  75.           slow  down the extracting.  You must be sure  that  the 
  76.           receiving party has access to uudecode.
  77.  
  78.      -v Print verbose feedback messages about what shar is  doing 
  79.           to be printed during extraction with the Bourne  Shell. 
  80.           Sizes  of  plain  files are echoed to  allow  a  simple 
  81.           validity check.
  82.  
  83. AUTHOR
  84.      Rainer Klute (highly based on Unix shar by Gary Perlman  and 
  85.      ST shar by J. Altstadt.
  86.  
  87. LIMITATIONS
  88.      The extraction algorithm is not too clever. It only recogni-
  89.      zes  filenames and the file contents as such.  So shar  does 
  90.      not  regard  any of the options -c,  -m or -v if  they  were 
  91.      specified upon creation of the archive.
  92.  
  93.